Skip to content

Conversation

@shouryathakur-sorcerer
Copy link

What kind of change does this PR introduce?

This PR introduces a documentation update to clarify what the “Scorecard webviewer” refers to and how it should be used.

  • PR title follows the guidelines defined in our pull request documentation

What is the current behavior?

The documentation refers to a “webviewer” without clearly explaining what it is, where it is hosted, or how users should interpret the term.

What is the new behavior (if this is a feature change)?

The documentation now explicitly explains that the Scorecard webviewer is the web UI available at https://scorecard.dev/viewer/ and clarifies how the URL template should be used.

  • Tests for the changes have been added (not applicable for documentation-only changes)

Which issue(s) this PR fixes

Fixes #3986

Special notes for your reviewer

This change is documentation-only and does not affect Scorecard behavior or outputs.

Does this PR introduce a user-facing change?

Clarified documentation describing the Scorecard webviewer and its URL template.

shouryathakur-sorcerer added 2 commits December 22, 2025 11:01
Signed-off-by: shouryathakur-sorcerer <shourya.thakur2025@gmail.com>
Signed-off-by: shouryathakur-sorcerer <shourya.thakur2025@gmail.com>
@dosubot dosubot bot added the size:XS This PR changes 0-9 lines, ignoring generated files. label Dec 22, 2025
@shouryathakur-sorcerer
Copy link
Author

Thank You for reviewing!
This PR is documentation-only and ready for review whenever convenient.

@github-actions
Copy link

github-actions bot commented Jan 2, 2026

This pull request has been marked stale because it has been open for 10 days with no activity

@github-actions github-actions bot added the Stale label Jan 2, 2026
Signed-off-by: shouryathakur-sorcerer <shourya.thakur2025@gmail.com>
@github-actions github-actions bot removed the Stale label Jan 8, 2026
@spencerschrock
Copy link
Member

Take a look at how this is rendering on github
https://github.com/shouryathakur-sorcerer/scorecard/blob/1afd38d5a5d3c7dc27cbb6f6de8fe5820d5071cb/docs/faq.md#can-i-preview-my-projects-score

You'll need to fix the link syntax to fix whatever you were intending.

@github-actions
Copy link

This pull request has been marked stale because it has been open for 10 days with no activity

@github-actions github-actions bot added the Stale label Jan 19, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size:XS This PR changes 0-9 lines, ignoring generated files. Stale

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

README/FAQ: Unclear references to "the webviewer"

3 participants